ltecat17 2.2.3
Loading...
Searching...
No Matches
LTE Cat.1 7 Click Driver

API for configuring and manipulating LTE Cat.1 7 Click driver. More...

Topics

 LTE Cat.1 7 Device Settings
 Settings for registers of LTE Cat.1 7 Click driver.
 LTE Cat.1 7 MikroBUS Map
 MikroBUS pin mapping of LTE Cat.1 7 Click driver.

Functions

void ltecat17_cfg_setup (ltecat17_cfg_t *cfg)
 LTE Cat.1 7 configuration object setup function.
err_t ltecat17_init (ltecat17_t *ctx, ltecat17_cfg_t *cfg)
 LTE Cat.1 7 initialization function.
err_t ltecat17_generic_write (ltecat17_t *ctx, uint8_t *data_in, uint16_t len)
 LTE Cat.1 7 data writing function.
err_t ltecat17_generic_read (ltecat17_t *ctx, uint8_t *data_out, uint16_t len)
 LTE Cat.1 7 data reading function.
void ltecat17_set_pwr_pin (ltecat17_t *ctx, uint8_t state)
 LTE Cat.1 7 set PWR pin function.
void ltecat17_set_rts_pin (ltecat17_t *ctx, uint8_t state)
 LTE Cat.1 7 set RTS pin function.
uint8_t ltecat17_get_ring_pin (ltecat17_t *ctx)
 LTE Cat.1 7 get RING pin function.
uint8_t ltecat17_get_cts_pin (ltecat17_t *ctx)
 LTE Cat.1 7 get CTS pin function.
void ltecat17_set_power_state (ltecat17_t *ctx, uint8_t state)
 LTE Cat.1 7 set power state function.
void ltecat17_cmd_run (ltecat17_t *ctx, uint8_t *cmd)
 LTE Cat.1 7 cmd run function.
void ltecat17_cmd_set (ltecat17_t *ctx, uint8_t *cmd, uint8_t *value)
 LTE Cat.1 7 cmd set function.
void ltecat17_cmd_get (ltecat17_t *ctx, uint8_t *cmd)
 LTE Cat.1 7 cmd get function.
void ltecat17_cmd_help (ltecat17_t *ctx, uint8_t *cmd)
 LTE Cat.1 7 cmd help function.
void ltecat17_set_sim_apn (ltecat17_t *ctx, uint8_t *sim_apn)
 Set sim card APN.
void ltecat17_send_sms_text (ltecat17_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
 LTE Cat.1 7 send SMS in text mode.
err_t ltecat17_send_sms_pdu (ltecat17_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
 LTE Cat.1 7 send SMS in PDU mode.

Detailed Description

API for configuring and manipulating LTE Cat.1 7 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ ltecat17_cfg_setup()

void ltecat17_cfg_setup ( ltecat17_cfg_t * cfg)

LTE Cat.1 7 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See ltecat17_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ ltecat17_cmd_get()

void ltecat17_cmd_get ( ltecat17_t * ctx,
uint8_t * cmd )

LTE Cat.1 7 cmd get function.

This function is used to get the value of a given command from the Click module.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]cmd: Command string.
Returns
None.
Note
None.

◆ ltecat17_cmd_help()

void ltecat17_cmd_help ( ltecat17_t * ctx,
uint8_t * cmd )

LTE Cat.1 7 cmd help function.

This function provides a short description of the given command of the Click module.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]cmd: Command string.
Returns
None.
Note
None.

◆ ltecat17_cmd_run()

void ltecat17_cmd_run ( ltecat17_t * ctx,
uint8_t * cmd )

LTE Cat.1 7 cmd run function.

This function sends a specified command to the Click module.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]cmd: Command string.
Returns
None.
Note
None.

◆ ltecat17_cmd_set()

void ltecat17_cmd_set ( ltecat17_t * ctx,
uint8_t * cmd,
uint8_t * value )

LTE Cat.1 7 cmd set function.

This function sets a value to a specified command of the Click module.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]cmd: Command string.
[in]value: Value string.
Returns
None.
Note
None.

◆ ltecat17_generic_read()

err_t ltecat17_generic_read ( ltecat17_t * ctx,
uint8_t * data_out,
uint16_t len )

LTE Cat.1 7 data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • >0 - Number of data bytes read,
  • <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.
Note
None.

◆ ltecat17_generic_write()

err_t ltecat17_generic_write ( ltecat17_t * ctx,
uint8_t * data_in,
uint16_t len )

LTE Cat.1 7 data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]data_in: Data buffer for sending.
[in]len: Number of bytes for sending.
Returns
  • >=0 - Success,
  • <0 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ltecat17_get_cts_pin()

uint8_t ltecat17_get_cts_pin ( ltecat17_t * ctx)

LTE Cat.1 7 get CTS pin function.

This function returns the clear to send (CTS) pin logic state.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ ltecat17_get_ring_pin()

uint8_t ltecat17_get_ring_pin ( ltecat17_t * ctx)

LTE Cat.1 7 get RING pin function.

This function returns the ring indication (RING) pin logic state.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ ltecat17_init()

err_t ltecat17_init ( ltecat17_t * ctx,
ltecat17_cfg_t * cfg )

LTE Cat.1 7 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters
[out]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See ltecat17_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ltecat17_send_sms_pdu()

err_t ltecat17_send_sms_pdu ( ltecat17_t * ctx,
uint8_t * service_center_number,
uint8_t * phone_number,
uint8_t * sms_text )

LTE Cat.1 7 send SMS in PDU mode.

This function sends text message to a phone number in PDU mode.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]service_center_numberSMSC of the SIM card.
[in]phone_numberPhone number to message.
[in]sms_textMessage to be sent.
Returns
  • >=0 - Success,
  • <0 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ltecat17_send_sms_text()

void ltecat17_send_sms_text ( ltecat17_t * ctx,
uint8_t * phone_number,
uint8_t * sms_text )

LTE Cat.1 7 send SMS in text mode.

This function sends text message to a phone number.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]phone_numberPhone number to message.
[in]sms_textMessage to be sent.
Returns
Nothing.
Note
None.

◆ ltecat17_set_power_state()

void ltecat17_set_power_state ( ltecat17_t * ctx,
uint8_t state )

LTE Cat.1 7 set power state function.

This function sets a desired power state by toggling PWR pin with a specific time for high state.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]state:
  • 0 - Power OFF,
  • 1 - Power ON.
Returns
None.
Note
None.

◆ ltecat17_set_pwr_pin()

void ltecat17_set_pwr_pin ( ltecat17_t * ctx,
uint8_t state )

LTE Cat.1 7 set PWR pin function.

This function sets the PWRKEY pin logic state.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]state: Pin logic state.
Returns
None.
Note
None.

◆ ltecat17_set_rts_pin()

void ltecat17_set_rts_pin ( ltecat17_t * ctx,
uint8_t state )

LTE Cat.1 7 set RTS pin function.

This function sets the request to send (RTS) pin logic state.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]state: Pin logic state.
Returns
None.
Note
None.

◆ ltecat17_set_sim_apn()

void ltecat17_set_sim_apn ( ltecat17_t * ctx,
uint8_t * sim_apn )

Set sim card APN.

This function sets APN for sim card.

Parameters
[in]ctx: Click context object. See ltecat17_t object definition for detailed explanation.
[in]sim_apnSIM card APN.
Returns
Nothing.
Note
None.